optimize compact_path() in pytest discovery for the common case#26016
Open
vaclavHala wants to merge 1 commit into
Open
optimize compact_path() in pytest discovery for the common case#26016vaclavHala wants to merge 1 commit into
vaclavHala wants to merge 1 commit into
Conversation
…ommon case before using expensive relative_to
Author
|
Hello @eleanorjboyd should I create a separate issue for this? |
There was a problem hiding this comment.
Pull request overview
This PR optimizes pytest discovery payload compaction by avoiding the relatively expensive pathlib.Path.relative_to() for the common case where a node’s absolute path is nested under the discovery root, using a cheaper string-prefix check and substring instead.
Changes:
- Adds a fast-path in
compact_path()usingstr.startswith()+ slicing, and passes precomputed base-path strings through the compaction pipeline to avoid repeated conversions. - Updates
compact_test_id()/compact_test_node()/create_compact_discovery_payload()signatures and call sites to propagate the precomputed base strings. - Updates an existing discovery compaction test to match the new function signatures.
Show a summary per file
| File | Description |
|---|---|
python_files/vscode_pytest/__init__.py |
Introduces the startswith/substring optimization and threads precomputed base-path strings through the compacting functions. |
python_files/tests/pytestadapter/test_discovery.py |
Updates existing assertions to call the new signatures for compact_path() / compact_test_id(). |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Low
Comment on lines
+1018
to
+1026
| # pathlib.Path.relative_to is an expensive operation, | ||
| # for common cases where path is nested in path_base and path_base is therefore a prefix | ||
| # we skip the expensive check and just chop off the prefix to yield relative path | ||
| if path_str.startswith(path_base_str): | ||
| # +1 because pathlib.Path never ends by a trailing separator which we also need to chop off: | ||
| # path_base_str= /some/prefix | ||
| # path_str= /some/prefix/tests/mytest.py | ||
| rel_str = path_str[(len(path_base_str) + 1):] | ||
| return "." if rel_str == "" else rel_str |
Comment on lines
81
to
89
| def test_compact_discovery_payload_keeps_paths_outside_base_absolute(tmp_path): | ||
| base_path = tmp_path / "workspace" | ||
| external_file = tmp_path / "external" / "test_external.py" | ||
|
|
||
| assert vscode_pytest.compact_path(external_file, base_path) == os.fspath(external_file) | ||
| assert vscode_pytest.compact_path(external_file, base_path, str(base_path)) == os.fspath(external_file) | ||
| assert ( | ||
| vscode_pytest.compact_test_id(f"{os.fspath(external_file)}::test_external", base_path) | ||
| vscode_pytest.compact_test_id(f"{os.fspath(external_file)}::test_external", base_path, str(base_path)) | ||
| == f"{os.fspath(external_file)}::test_external" | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I tested the latest changes to discovery where absolute paths get compacted to global prefix + relative path in each test node, and this change has made the discovery 2 to 3 times slower for us.
The problem is mainly the
pathlib.Path.relative_tooperation which is relatively expensive:This PR adds optimization which first checks using simple
str.startswithif the test is in some subfolder of the root, in which case creating of the relative path is done as trivial (and cheap) substring:I pass the base paths as both
strandpathlib.Path.relative_toso each operation can use whichever form of the base path is needed without having to convert to the other, i.e.str(pathlibPath), which in my testing also adds noticeable overhead.